Broadband Availability API
How to use the API
The table below outlines how the Broadband Availability API operates.
| API Function | How it works | What it can be used for |
|---|---|---|
| Retrieve Service Availability Information | Calling resource /service with a Chorus identifier in the form of either TLC or PLSAM returns service availability information. | Enables an external application to use the API to retrieve service availability information. |
The table below provides the meaning of different information returned from the Broadband Availability API.
| Data Group | Field | Description | Copper / Fibre | Data Type | Example / Values |
|---|---|---|---|---|---|
| Timestamp | Fibre Data Update Date Time | The date and time of the fibre data update. Notes / Rules: Where time stamp is not available, it will be set as 00:00:00. | Both | ISO Date (Full length with timezone) | 2017-08-21T15:37:17+12:00 |
| Timestamp | Copper Data Update Date Time | The date and time of the copper data update. (NZT). Notes / Rules: Where time stamp is not available, it will be set as 00:00:00. | Both | ISO Date (Full length with timezone) | 2017-08-21T15:37:17+12:00 |
| Address | PLSAM | POTS Line Service Area Master. Unique address identifier used in copper systems such as ICMS and Wireline. Also known as SAM ID. Notes / Rules: A number between 1 – 9999999. | Copper | Number | 84529 |
| Address | Premise Wiring Recommended | Where the address is VDSL capable, this field will indicate whether a Connection and Wiring field service is strongly recommended to achieve the VDSL speed benefits. | Copper | String | "Y", "N", null |
| Exchange / Cabinet / DSLAM | Serving LWC Name | Loop Wire Centre. Chorus location ID that defines beginning of the copper local loop. This is either an active cabinet or exchange. | Copper | String | ON - ON/S |
| Attenuation | Line Attenuation Low | Theoretical attenuation based on loop length. Line Attenuation Downstream as recorded in Netmap for the cable path from ICMS. Attenuation is calculated at 160kHz. In the case of an RLG cable system this is the attenuation to the far end of the RLG. In most cases the high and low attenuation values are the same. The attenuation value will include 3 decimal places. | Copper | String | 4.000 |
| Attenuation | Line Attenuation High | Theoretical attenuation based on loop length. Line Attenuation Downstream as recorded in Netmap for the cable path from ICMS. Attenuation is calculated at 160kHz. In the case of an RLG cable system this is the attenuation to the far end of the RLG. In most cases, the high and low attenuation values are the same. The attenuation value will include 3 decimal places. | Copper | String | 4.000 |
| Products (capable) | BUBA Capable | Indicates if the address is BUBA Capable. Basic Unbundled Bitstream Access. A regulated best endeavours internet grade Bitstream access service). Notes / Rules: If the address is BUBA capable then “Y” If the address is not BUBA capable then “N” If the address is inconclusive for BUBA then “?” | Copper | String | “Y”, “N”, “?” |
| Products (capable) | EUBA Capable | Indicates if the address is EUBA Capable. Enhanced Unbundled Bitstream Access - A DSL based service running over Chorus’s Next Generation Copper Network (Ethernet based) available for resale to ISP’s. Enhancements over BUBA include separate Real Time and Internet grade traffic channels, various bandwidth options, and 100% ADSL2+ compatibility. Notes / Rules: If the address is EUBA capable then “Y” If the address is not EUBA capable then “N” If the address is inconclusive for EUBA then “?” | Copper | String | “Y”, “N”, “?” |
| Products (capable) | ADSL Capable | Asynchronous Digital Subscriber Line 2 - indicates if the address is ADSL capable. Newer ADSL (Broadband) technology) technology for delivering a high bit rate link to customers over ordinary copper to provide a broadband service. Notes / Rules: If the BUBA capable or EUBA capable field contains “Y” then “Y”. If the BUBA capable or EUBA capable field does not contain “Y” then “N”. | Copper | String | “Y”, “N”, “?” |
| Products (capable) | VDSL Capable | Very High Speed Digital Subscriber Line - indicates if the address is VDSL Capable. Very-high-bitrate digital subscriber line is a digital subscriber line (DSL) technology providing faster data transmission over a single flat untwisted or twisted pair of copper wires. Notes / Rules: If the address is VDSL capable then “Y” If the address is not VDSL capable then “N” If the address is inconclusive for VDSL then “?” | Copper | String | “Y”, “N”, “?” |
| Products (capable) | Baseband IP Capable | Indicates if the address is Baseband IP Capable. A Chorus product enabling service providers to provide voice service from their own exchange based equipment using Chorus ISAMS and splitters in cabinets or exchanges. Baseband IP provides a copper delivery to the end user address and a SIP Bitstream interface to the RSP. Baseband IP can be provided standalone or in conjunction with a Broadband service. Notes / Rules: If the address is Baseband IP capable then “Y” If the address is not Baseband IP capable then “N” If the address is inconclusive for Baseband IP then “?” | Copper | String | “Y”, “N”, “?” |
| Products (capable) | Baseband Copper Capable | Indicates if the address is Baseband Copper capable. Notes / Rules: If the address is Baseband Copper capable then “Y” If the address is not Baseband Copper capable then “N” If the address is inconclusive for Baseband Copper then “?” | Copper | String | “Y”, “N”, “?” |
| Product (active) | BUBA Active | Indicates if there's an active BUBA service, or services, at the address. Notes / Rules: If there is a working BUBA service then “Y” If there is no working BUBA service then “N” | Copper | String | “Y”, “N” |
| Product (active) | EUBA Active | Indicates if there's an active EUBA service, or services, at the address. Notes / Rules: If there is a working EUBA service then “Y” If there is no working EUBA service then “N” | Copper | String | “Y”, “N” |
| Product (active) | ADSL Active | Indicates if there's an active ADSL service, or services, at the address. Notes / Rules: If there is a working BUBA or EUBA Service then “Y” If there is no working BUBA or EUBA service then “N” | Copper | String | “Y”, “N” |
| Product (active) | VDSL Active | Indicates if there's an active VDSL service, or services, at the address. Notes / Rules: If there is a working VDSL Service then “Y” If there is no working VDSL service then “N” | Copper | String | “Y”, “N” |
| Product (active) | Multiple Active Services | A flag to indicate if there are multiple active copper broadband services at the address. Where there are multiple copper broadband services at an address the cache stores the lowest active speed for each DSL type (the lowest ADSL and lowest VDSL speed). Notes / Rules: If the working count of active VDSL and ADSL services is greater than 1 then, “Y” If the working count of active VDSL and ADSL services is 1 or 0, then “N” | Copper | String | “Y”, “N” |
| Exchange / Cabinet / DSLAM | CABINET | Describes whether the LWC is a cabinet. Chorus cabinets are used for copper and fibre distribution. | Copper | String | TRUE, FALSE |
| Exchange / Cabinet / DSLAM | Vectoring Enabled | Indicates if the premise is connected to a cabinet that is vectoring enabled. | Copper | String | "TRUE", "FALSE", null |
| Exchange / Cabinet / DSLAM | Cable ID | The Cable ID. Cable ID for the cable upstream from the cable terminal or cabinet. Must be associated with the Pair number. Note: Cable IDs suffixed with a number connect to an exchange and those with letters connect to a cabinet. | Copper | String | GID K |
| Exchange / Cabinet / DSLAM | Pair Number | The cable pair number. | Copper | String | 261 |
| Exchange / Cabinet / DSLAM | Cable Terminal Locality ID | Locality ID and Connector_ID fields identify a Cable Terminal (cabinet or exchange). | Copper | String | GID |
| Exchange / Cabinet / DSLAM | Connector ID | The Connector ID. | Copper | String | O13/2 |
| Speed | ADSL Download Rate Low | This is the predicted ADSL download rate based on Netmap loop length (applies to ADSL and ADSL2+). | Copper | String | 12.2 |
| Speed | ADSL Download Rate High | This is the predicted ADSL Download Rate based on Netmap loop length (applies to ADSL and ADSL2+). | Copper | String | 12.2 |
| Speed | VDSL2 Prediction Date | The date of the most recent VDSL2 Prediction. | Copper | ISO Date (Full length with timezone) | 2017-08-21T15:37:17+12:00 |
| Speed | VDSL2 Prediction Down Speed | The predicted VDSL download speed based on the most recent data. The predicted speed and source of speed can change on a weekly basis. Predicted download speed is an adjusted speed based on the prediction method used and the raw predicted speed, for example, for upgrade predictor a raw speed of 78573 is moderated by 6000 to 72573 then rounded to the nearest Mbps. | Copper | String | 0 |
| Speed | VDSL2 Prediction Up Speed | The predicted VDSL upload speed based on the most recent data. The predicted speed and source of speed can change on a weekly basis. Predicted upload speed is an adjusted speed in Mbps based on the prediction method used and the raw predicted speed. | Copper | String | 0 |
| Speed | VDSL2 Prediction Down Min | The predicted VDSL2 downstream speed, minimum. | Copper | String | 0 |
| Speed | VDSL2 Prediction Down Max | The predicted VDSL2 downstream speed, maximum. | Copper | String | 67000 |
| Speed | VDSL2 Prediction Method | The method that was used to provide the prediction from the hierarchy of methods, for example, MEAN, CURRENT, HISTORIC, CURRENT PREDICTOR, NEAR NEIGHBOUR, HISTORIC PREDDICTOR <1 YR. | Copper | String | Mean and Standard Deviation, Current Connection, Historic Connection, Upgrade Prediction, Nearest Neighbour, Historic Connection, Netmap Theoretical |
| Speed | ADSL2p Prediction Down Speed | Predicted ADSL2+ Download speed in Mbps which is an adjusted speed based on the prediction method used and the raw predicted speed. Notes / Rules: Blank for Phase One. | Copper | String | 10 |
| Speed | ADSL2p Prediction Up Speed | Predicted ADSL2+ Upload speed which is an adjusted speed in Mbps based on the prediction method used and the raw predicted speed. Notes / Rules: Blank for Phase One. | Copper | String | 3 |
| Speed | Current Down Speed | Best download speed being observed for the best DSL technology in use at the address. | Copper | String | 22 |
| Speed | Current Up Speed | Best upload speed being observed for the best DSL technology in use at the address. | Copper | String | 12 |
| Speed | Backhaul Restrict | Identifies services on Alcatel FASTMUX_2000 (Conklin) DSLAMs where there is only one 2Mbit/s backhaul. | Copper | String | TRUE, FALSE |
| Speed | ADSL2p Prediction Date | The date of the most recent ADSL2 prediction. Notes / Rules: Blank for Phase One. | Copper | ISO Date (Full length with timezone) | 2017-08-21T15:37:17+12:00 |
| Address | TLC | Telecom Location Code. Unique address identifier used in fibre systems. Contains nine numeric characters. | Fibre | Number (length 9) | 100394624 |
| Fibre Availability Status | Fibre Availability Status | The status of the fibre roll out. If the status is equal to Ready then the address is NGA Capable. | Fibre | String | Unplanned, Ready, Unknown, Under Build, Planned |
| Fibre Availability Status | Fibre Install Lead Time | The potential lead time needed for the fibre installation at a given address. The Fibre Install Lead Time is identified when 20% of the appointments in the schedule of appointments are unassigned for three consecutive working days. Appointments may be available before the stated lead time. However, it provides an indication of when our technician availability will increase. Lead times do not account for complicated installations or consenting processes, which can vary from property to property. Our connection times assume that you are available for your scoping and installation appointments which are booked for you. Times also assume that your modem supplied by your broadband provider is available for installation. There are a number of factors that can impact lead and installation times including:
Fibre Install Lead time is provided by the installLeadTime attribute. |
Fibre | String | 3 |
| Exchange / Cabinet / DSLAM | Central Office | Chorus Exchange / Central Office. The place where the retail service provider’s network connects to the Chorus network. The Central Office is a small satellite exchange connected to the Point of Interconnect a larger exchange. | Fibre | String | TRUE |
| Consents | Consent Required | Describes whether consent is required based on dwelling type and ROW. | Fibre | String | “Y”, “N” |
| Consents | Consent Status | The status of the consent. | Fibre | String | Build Consent Gained, Existing Rights, Consent Declined, Consent Under Action, Not Required |
| Consents | Dwelling Type | This field is also called _Demand point_ type. | Fibre | String | SDU, MDU, Subdivision, Unknown |
| Exchange / Cabinet / DSLAM | Final Cabinet ID | Chorus cabinet identifier. | Fibre | String | ETM / CL |
| Fibre Availability Status | Greenfields | Yes, No. | Fibre | String | “Y”, “N” |
| Consents | MDU Build Status | The build status of the MDU. | Fibre | String | Design and Build Required, Ready for Provisioning, Not Required |
| Consents | MDU Class | MDU's are classified 0-6\. (0= SDU 0, 1 = 2-5 addresses, 2 = 6-21 addresses, 3 = 22-31 Addresses, 4 = >32 addresses, 5= Greenfields MDU's, 6= Special MDUs). | Fibre | String | 0-6 (0 = SDU) |
| Consents | MDU Design Status | The design status of the MDU. | Fibre | String | NULL, Design Approved, Design Under Action |
| Exchange / Cabinet / DSLAM | Planned Cabinet ID | Chorus Cabinet Identifier. The Planned cabinet ID will usually be the same as the cabinet ID and is a more reliable reference than the cabinet ID. | Fibre | String | POY AU |
| Exchange / Cabinet / DSLAM | Point of Interconnect | Chorus Exchange / Central Office. The place where the retail service provider’s network connects to the Chorus network. The Point of interconnect is a large Chorus exchange with a number of smaller exchanges connected to it. | Fibre | String | GLF / MDR |
| Exchange / Cabinet / DSLAM | Regional Point of Interconnect | Chorus Exchange / Central Office. The place where the retail service provider’s network connects to the Chorus network. The Point of interconnect is a large Chorus exchange with a number of smaller exchanges connected to it. | Fibre | String | GLF / MDR |
| Consents | Right of Way | Describes whether the address is part of a right of way (ROW). This influences the consenting process. | Fibre | String | “Y”, “N” |
| Build | Design Required | Describes whether design is required. | Fibre | String | “Y”, “N” |
| Build | Build Required | Describes whether build is required. | Fibre | String | “Y”, “N” |
| Build | Fibre in a day capable | Indicates if the address can have the scoping and installation done on the same day; without requiring 2 separate appointments. | Fibre | String | "Y", "N" |
| Build | Permit Delay Likely | There will be a likely delay on this property to acquire permits for working on third party poles, or to organise traffic management. This will be determined at the scope appointment, and next steps will be provided at that stage. | Fibre | String | "Y", "N" |
| Product (active) | NGA Service Status | Indicates if there's an active NGA service at the address. | Fibre | String | Multiple, Single, Disconnected, None |
| Speed | NGA Active Speed Up | The upstream speed associated with the active NGA plan. | Fibre | String | 20 |
| Speed | NGA Active Speed Down | The downstream speed associated with the active NGA plan. | Fibre | String | 30, 100, 200, 1000 |
| Location / Zone | Product Zone Type | The zone type is based on the LFC region / shape files. Notes / Rules: Duplicate of Zone Type. | Fibre | String | UFB, Non UFB, RBI |
| Exchange / Cabinet / DSLAM | ffpID | Indicates the FFP a given Address is connected to. | Fibre | String | "F-AEW568" |
| Address | fibreUnbundlingEnabled | Indicates if a given address is eligible for fibre unbundling. | Fibre | String | "Y", "N" |
| Address | fibreUnbundlingDate | Indicates the fibre unbundling date if a given address is eligible for fibre unbundling. | Fibre | String | "2020-01-01" |
Refer to API Summary for more information on field types, length and other restrictions.
UPDATE LINK TO WORKBOOK